<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketclient;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.codemonkey.util.Executable;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    /**<a name="line.5"></a>
<FONT color="green">006</FONT>     * Defines a base for decodable and executable message types.<a name="line.6"></a>
<FONT color="green">007</FONT>     * &lt;p&gt;<a name="line.7"></a>
<FONT color="green">008</FONT>     * With this base class, a message can decode a &lt;code&gt;String&lt;/code&gt; to fill itself. This interface is used to translate so called &lt;a<a name="line.8"></a>
<FONT color="green">009</FONT>     * href="http://gpwiki.org/index.php/Binary_Packet"&gt;Binary Packets&lt;/a&gt;, or datagrams, into {@link Executable} messages. This means an<a name="line.9"></a>
<FONT color="green">010</FONT>     * instance of {@link ClientMessageToServer} is very much a command-like object.<a name="line.10"></a>
<FONT color="green">011</FONT>     * &lt;p&gt;<a name="line.11"></a>
<FONT color="green">012</FONT>     * A response string needs to built up in the following format:&lt;br /&gt;<a name="line.12"></a>
<FONT color="green">013</FONT>     * message id (3), encoded string<a name="line.13"></a>
<FONT color="green">014</FONT>     * &lt;p&gt;<a name="line.14"></a>
<FONT color="green">015</FONT>     * The following example could of a login response: &lt;code&gt;0035admin7letmein&lt;/code&gt;&lt;br /&gt;<a name="line.15"></a>
<FONT color="green">016</FONT>     * The following example could of a pong notification: &lt;code&gt;999&lt;/code&gt;&lt;br /&gt;<a name="line.16"></a>
<FONT color="green">017</FONT>     * &lt;p&gt;<a name="line.17"></a>
<FONT color="green">018</FONT>     * It is up to the implementing class to decode this information and utilize it as an executable object.<a name="line.18"></a>
<FONT color="green">019</FONT>     * &lt;p&gt;<a name="line.19"></a>
<FONT color="green">020</FONT>     * <a name="line.20"></a>
<FONT color="green">021</FONT>     * @author Benny Bottema<a name="line.21"></a>
<FONT color="green">022</FONT>     * @param &lt;Controller&gt; The type to which the executable can defer to (also see {@link Executable#execute(Object)}).<a name="line.22"></a>
<FONT color="green">023</FONT>     * @see Executable The interface used by the server to execute the client message after it has been decoded.<a name="line.23"></a>
<FONT color="green">024</FONT>     * @see SwiftSocketClient#addServerResponse(ServerMessageToClient)<a name="line.24"></a>
<FONT color="green">025</FONT>     * @see SwiftSocketClient#getNextServerResponse()<a name="line.25"></a>
<FONT color="green">026</FONT>     * @since 1.0<a name="line.26"></a>
<FONT color="green">027</FONT>     */<a name="line.27"></a>
<FONT color="green">028</FONT>    public interface ServerMessageToClient&lt;Controller&gt; extends Executable&lt;Controller, UnknownMessageException&gt; {<a name="line.28"></a>
<FONT color="green">029</FONT>            /**<a name="line.29"></a>
<FONT color="green">030</FONT>             * Populates itself by decoding the given message content. How this is done is entirely up to the sub class implementation, as long as<a name="line.30"></a>
<FONT color="green">031</FONT>             * it is decoded the same way it was encoded.<a name="line.31"></a>
<FONT color="green">032</FONT>             * <a name="line.32"></a>
<FONT color="green">033</FONT>             * @param messageContent The string containing a message id and the message content to be decoded.<a name="line.33"></a>
<FONT color="green">034</FONT>             */<a name="line.34"></a>
<FONT color="green">035</FONT>            public abstract void decode(final String messageContent);<a name="line.35"></a>
<FONT color="green">036</FONT>    }<a name="line.36"></a>




























































</PRE>
</BODY>
</HTML>
